From: Florian Müllner Date: Wed, 28 Aug 2024 11:26:27 +0000 (+0200) Subject: man: Use .rst suffix for sources X-Git-Tag: archive/raspbian/50.5-1+rpi1~1^2~219^2^2~14 X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=ad448533cb451eedb11191492e1d051d38c39fe7;p=gnome-shell.git man: Use .rst suffix for sources It's more common to use the dedicated .rst suffix for reStructuredText files, so now that the files were ported, use that. (Renaming the files separately from changing it is less likely to confuse git, thus the separate commit) Part-of: --- diff --git a/man/gnome-shell.rst b/man/gnome-shell.rst new file mode 100644 index 000000000..d90ea5f6c --- /dev/null +++ b/man/gnome-shell.rst @@ -0,0 +1,109 @@ +=========== +gnome-shell +=========== + +------------------------------------- +Graphical shell for the GNOME desktop +------------------------------------- + +:Manual section: 1 +:Manual group: User Commands + +SYNOPSIS +-------- +**gnome-shell** [*OPTION*...] + +DESCRIPTION +----------- +GNOME shell provides core user interface functions for the GNOME 3 desktop, +like switching to windows and launching applications. GNOME shell takes +advantage of the capabilities of modern graphics hardware and introduces +innovative user interface concepts to provide a visually attractive and +easy to use experience. + +gnome-shell is a required component of the GNOME desktop, i.e. it is listed in +the RequiredComponents field of /usr/share/gnome-session/sessions/gnome.session. +It is started in the window manager phase of the session. + +OPTIONS +------- +``--wayland`` + + Run as a wayland compositor + +``--display-server`` + + Run as a full display server, rather than nested + +``--nested`` + + Run as a nested compositor + +``--no-x11`` + + Run wayland compositor without starting Xwayland + +``--x11`` + + Run with X11 backend + +``--wayland-display``\ =\ *DISPLAY* + + Wayland display name to use + +``-d``, ``--display``\ =\ *DISPLAY* + + X display to use + +``-r``, ``--replace`` + + Replace the running window manager + +``--sm-disable`` + + Disable connection to the session manager + +``--sm-client-id``\ =\ *ID* + + Specify session management *ID* + +``--sm-save-file``\ =\ *FILE* + + Initialize session from *FILE* + +``--sync`` + + Make X calls synchronous + +``--mode=MODE`` + + Use a specific mode, e.g. "gdm" for login screen + +``--list-modes`` + + List possible modes and exit + +``--version`` + + Print version and exit + +``--help`` + + Display help and exit + +FILES +----- +/usr/share/gnome-session/sessions/gnome.session, +/usr/share/applications/org.gnome.Shell.desktop. + +BUGS +---- +The bug tracker can be reached by visiting the website +https://gitlab.gnome.org/GNOME/gnome-shell/issues. +Before sending a bug report, please verify that you have the latest version +of gnome-shell. Many bugs (major and minor) are fixed at each release, and +if yours is out of date, the problem may already have been solved. + +ADDITIONAL INFORMATION +---------------------- +For further information, visit the website https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/README.md. diff --git a/man/gnome-shell.txt b/man/gnome-shell.txt deleted file mode 100644 index d90ea5f6c..000000000 --- a/man/gnome-shell.txt +++ /dev/null @@ -1,109 +0,0 @@ -=========== -gnome-shell -=========== - -------------------------------------- -Graphical shell for the GNOME desktop -------------------------------------- - -:Manual section: 1 -:Manual group: User Commands - -SYNOPSIS --------- -**gnome-shell** [*OPTION*...] - -DESCRIPTION ------------ -GNOME shell provides core user interface functions for the GNOME 3 desktop, -like switching to windows and launching applications. GNOME shell takes -advantage of the capabilities of modern graphics hardware and introduces -innovative user interface concepts to provide a visually attractive and -easy to use experience. - -gnome-shell is a required component of the GNOME desktop, i.e. it is listed in -the RequiredComponents field of /usr/share/gnome-session/sessions/gnome.session. -It is started in the window manager phase of the session. - -OPTIONS -------- -``--wayland`` - - Run as a wayland compositor - -``--display-server`` - - Run as a full display server, rather than nested - -``--nested`` - - Run as a nested compositor - -``--no-x11`` - - Run wayland compositor without starting Xwayland - -``--x11`` - - Run with X11 backend - -``--wayland-display``\ =\ *DISPLAY* - - Wayland display name to use - -``-d``, ``--display``\ =\ *DISPLAY* - - X display to use - -``-r``, ``--replace`` - - Replace the running window manager - -``--sm-disable`` - - Disable connection to the session manager - -``--sm-client-id``\ =\ *ID* - - Specify session management *ID* - -``--sm-save-file``\ =\ *FILE* - - Initialize session from *FILE* - -``--sync`` - - Make X calls synchronous - -``--mode=MODE`` - - Use a specific mode, e.g. "gdm" for login screen - -``--list-modes`` - - List possible modes and exit - -``--version`` - - Print version and exit - -``--help`` - - Display help and exit - -FILES ------ -/usr/share/gnome-session/sessions/gnome.session, -/usr/share/applications/org.gnome.Shell.desktop. - -BUGS ----- -The bug tracker can be reached by visiting the website -https://gitlab.gnome.org/GNOME/gnome-shell/issues. -Before sending a bug report, please verify that you have the latest version -of gnome-shell. Many bugs (major and minor) are fixed at each release, and -if yours is out of date, the problem may already have been solved. - -ADDITIONAL INFORMATION ----------------------- -For further information, visit the website https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/README.md. diff --git a/man/meson.build b/man/meson.build index 8aa332c10..c61bf5151 100644 --- a/man/meson.build +++ b/man/meson.build @@ -1,5 +1,5 @@ custom_target('man page', - input: 'gnome-shell.txt', + input: 'gnome-shell.rst', output: 'gnome-shell.1', command: [rst2man, '--syntax-highlight=none', '@INPUT@'], capture: true, diff --git a/subprojects/extensions-tool/man/gnome-extensions.rst b/subprojects/extensions-tool/man/gnome-extensions.rst new file mode 100644 index 000000000..1014abd53 --- /dev/null +++ b/subprojects/extensions-tool/man/gnome-extensions.rst @@ -0,0 +1,255 @@ +================ +gnome-extensions +================ + +----------------------------------------------- +Command line tool for managing GNOME extensions +----------------------------------------------- + +:Manual section: 1 +:Manual group: User Commands + +SYNOPSIS +-------- + +| **gnome-extensions** help [*COMMAND*] +| **gnome-extensions** version +| **gnome-extensions** enable *UUID* +| **gnome-extensions** disable *UUID* +| **gnome-extensions** reset *UUID* +| **gnome-extensions** info *UUID* +| **gnome-extensions** show *UUID* +| **gnome-extensions** list [*OPTION*...] +| **gnome-extensions** prefs *UUID* +| **gnome-extensions** create [*OPTION*...] +| **gnome-extensions** pack [*OPTION*...] +| **gnome-extensions** install [*OPTION*...] *PACK* +| **gnome-extensions** uninstall *UUID* + +DESCRIPTION +----------- +``gnome-extensions`` is a utility that makes some common GNOME extensions +operations available on the command line. + +COMMON OPTIONS +-------------- +All commands except for ``help`` and ``version`` handle the following options: + +``--quiet``, ``-q`` + + Do not print error messages + +COMMANDS +-------- +``help`` [*COMMAND*] + + Displays a short synopsis of the available commands or provides + detailed help on a specific command. + +``version`` + + Prints the program version. + +``enable`` *UUID* + + Enables the extension identified by *UUID*. + + The command will not detect any errors from the extension itself, use the + ``info`` command to confirm that the extension state is *ACTIVE*. + + If the extension is already enabled, the command will do nothing. + +``disable`` *UUID* + + Disables the extension identified by *UUID*. + + If the extension is not enabled, the command will do nothing. + +``reset`` *UUID* + + Reset the extension identified by *UUID*. + + The extension will be disabled in GNOME, but may be enabled by other sessions + like GNOME Classic. + +``info`` *UUID* + + Show details of the extension identified by *UUID*, including name, + description and state. + +``show`` *UUID* + + Synonym of info. + +``list`` [*OPTION*...] + + Displays a list of installed extensions. + + **Options** + + ``--user`` + + Include extensions installed in the user's ``$HOME`` + + ``--system`` + + Include extensions installed in the system + + ``--enabled`` + + Include enabled extensions + + ``--disabled`` + + Include disabled extensions + + ``--active`` + + Only include extensions in active state + + ``--inactive`` + + Only include extensions in inactive state + + ``--prefs`` + + Only include extensions with preferences + + ``--updates`` + + Only include extensions with pending updates + + ``-d``, ``--details`` + + Show some extra information for each extension + +``prefs`` *UUID* + + Open the preference dialog of the extension identified by *UUID*. + + +``create`` [*OPTION*...] + + Creates a new extension from a template. + + **Options** + + ``--name``\ =\ *NAME* + + Set the user-visible name in the extension's metadata + to *NAME* + + ``--description``\ =\ *DESC* + + Set the description in the extension's metadata to *DESC* + + ``--uuid``\ =\ *UUID* + + Set the unique extension ID in the metadata to *UUID* + + ``--gettext-domain``\ =\ *DOMAIN* + + Set the gettext domain used by the extension + + ``--settings-schema``\ =\ *SCHEMA* + + Set the GSettings schema used by the extension + + ``--template``\ =\ *TEMPLATE* + + Use *TEMPLATE* as base for the new extension + + ``--prefs`` + + Include a prefs.js template + + ``-i``, + ``--interactive`` + + Prompt for any extension metadata that hasn't been provided + on the command line + +``pack`` [*OPTION*...] [*SOURCE-DIRECTORY*] + + Creates an extension bundle that is suitable for publishing. + + The bundle will always include the required files extension.js + and metadata.json, as well as any of the optional stylesheet.css, + stylesheet-dark.css, stylesheet-light.css or prefs.js if found. + Each additional source that should be included must be specified + with ``--extra-source``. + + If the extension includes one or more GSettings schemas, they can + either be placed in a schemas/ folder to be picked up automatically, + or be specified with ``--schema``. + + Similarily, translations are included automatically when they are + located in a po/ folder, otherwise the ``--podir`` option can be + used to point to the correct directory. If no gettext domain is + provided on the command line, the value of the ``gettext-domain`` + metadata field is used if it exists, and the extension UUID + if not. + + All files are searched in *SOURCE-DIRECTORY* if specified, or + the current directory otherwise. + + **Options** + + ``--extra-source``\ =\ *FILE* + + Additional source to include in the bundle + + ``--schema``\ =\ *SCHEMA* + + A GSettings schema that should be compiled and + included + + ``--podir``\ =\ *PODIR* + + A directory with translations that should be + compiled and included + + ``--gettext-domain``\ =\ *DOMAIN* + + The gettext domain to use for translations + + ``-f``, ``--force`` + + Overwrite an existing pack + + ``-o``, ``--out-dir``\ =\ *DIRECTORY* + + The directory where the pack should be created + +``install`` [*OPTION*...] *PACK* + + Installs an extension from the bundle *PACK*. + + The command unpacks the extension files and moves them to + the expected location in the user's ``$HOME``, so that it + will be loaded in the next session. + + It is mainly intended for testing, not as a replacement for + the extension website. As extensions have privileged access + to the user's session, it is advised to never load extensions + from untrusted sources without carefully reviewing their content. + + **Options** + + ``--force`` + + Override an existing extension + +``uninstall`` *UUID* + + Uninstalls the extension identified by *UUID*. + + +EXIT STATUS +----------- +On success 0 is returned, a non-zero failure code otherwise. + +BUGS +---- +The tool is part of the gnome-shell project, and bugs should be reported +in its issue tracker at https://gitlab.gnome.org/GNOME/gnome-shell/issues. diff --git a/subprojects/extensions-tool/man/gnome-extensions.txt b/subprojects/extensions-tool/man/gnome-extensions.txt deleted file mode 100644 index 1014abd53..000000000 --- a/subprojects/extensions-tool/man/gnome-extensions.txt +++ /dev/null @@ -1,255 +0,0 @@ -================ -gnome-extensions -================ - ------------------------------------------------ -Command line tool for managing GNOME extensions ------------------------------------------------ - -:Manual section: 1 -:Manual group: User Commands - -SYNOPSIS --------- - -| **gnome-extensions** help [*COMMAND*] -| **gnome-extensions** version -| **gnome-extensions** enable *UUID* -| **gnome-extensions** disable *UUID* -| **gnome-extensions** reset *UUID* -| **gnome-extensions** info *UUID* -| **gnome-extensions** show *UUID* -| **gnome-extensions** list [*OPTION*...] -| **gnome-extensions** prefs *UUID* -| **gnome-extensions** create [*OPTION*...] -| **gnome-extensions** pack [*OPTION*...] -| **gnome-extensions** install [*OPTION*...] *PACK* -| **gnome-extensions** uninstall *UUID* - -DESCRIPTION ------------ -``gnome-extensions`` is a utility that makes some common GNOME extensions -operations available on the command line. - -COMMON OPTIONS --------------- -All commands except for ``help`` and ``version`` handle the following options: - -``--quiet``, ``-q`` - - Do not print error messages - -COMMANDS --------- -``help`` [*COMMAND*] - - Displays a short synopsis of the available commands or provides - detailed help on a specific command. - -``version`` - - Prints the program version. - -``enable`` *UUID* - - Enables the extension identified by *UUID*. - - The command will not detect any errors from the extension itself, use the - ``info`` command to confirm that the extension state is *ACTIVE*. - - If the extension is already enabled, the command will do nothing. - -``disable`` *UUID* - - Disables the extension identified by *UUID*. - - If the extension is not enabled, the command will do nothing. - -``reset`` *UUID* - - Reset the extension identified by *UUID*. - - The extension will be disabled in GNOME, but may be enabled by other sessions - like GNOME Classic. - -``info`` *UUID* - - Show details of the extension identified by *UUID*, including name, - description and state. - -``show`` *UUID* - - Synonym of info. - -``list`` [*OPTION*...] - - Displays a list of installed extensions. - - **Options** - - ``--user`` - - Include extensions installed in the user's ``$HOME`` - - ``--system`` - - Include extensions installed in the system - - ``--enabled`` - - Include enabled extensions - - ``--disabled`` - - Include disabled extensions - - ``--active`` - - Only include extensions in active state - - ``--inactive`` - - Only include extensions in inactive state - - ``--prefs`` - - Only include extensions with preferences - - ``--updates`` - - Only include extensions with pending updates - - ``-d``, ``--details`` - - Show some extra information for each extension - -``prefs`` *UUID* - - Open the preference dialog of the extension identified by *UUID*. - - -``create`` [*OPTION*...] - - Creates a new extension from a template. - - **Options** - - ``--name``\ =\ *NAME* - - Set the user-visible name in the extension's metadata - to *NAME* - - ``--description``\ =\ *DESC* - - Set the description in the extension's metadata to *DESC* - - ``--uuid``\ =\ *UUID* - - Set the unique extension ID in the metadata to *UUID* - - ``--gettext-domain``\ =\ *DOMAIN* - - Set the gettext domain used by the extension - - ``--settings-schema``\ =\ *SCHEMA* - - Set the GSettings schema used by the extension - - ``--template``\ =\ *TEMPLATE* - - Use *TEMPLATE* as base for the new extension - - ``--prefs`` - - Include a prefs.js template - - ``-i``, - ``--interactive`` - - Prompt for any extension metadata that hasn't been provided - on the command line - -``pack`` [*OPTION*...] [*SOURCE-DIRECTORY*] - - Creates an extension bundle that is suitable for publishing. - - The bundle will always include the required files extension.js - and metadata.json, as well as any of the optional stylesheet.css, - stylesheet-dark.css, stylesheet-light.css or prefs.js if found. - Each additional source that should be included must be specified - with ``--extra-source``. - - If the extension includes one or more GSettings schemas, they can - either be placed in a schemas/ folder to be picked up automatically, - or be specified with ``--schema``. - - Similarily, translations are included automatically when they are - located in a po/ folder, otherwise the ``--podir`` option can be - used to point to the correct directory. If no gettext domain is - provided on the command line, the value of the ``gettext-domain`` - metadata field is used if it exists, and the extension UUID - if not. - - All files are searched in *SOURCE-DIRECTORY* if specified, or - the current directory otherwise. - - **Options** - - ``--extra-source``\ =\ *FILE* - - Additional source to include in the bundle - - ``--schema``\ =\ *SCHEMA* - - A GSettings schema that should be compiled and - included - - ``--podir``\ =\ *PODIR* - - A directory with translations that should be - compiled and included - - ``--gettext-domain``\ =\ *DOMAIN* - - The gettext domain to use for translations - - ``-f``, ``--force`` - - Overwrite an existing pack - - ``-o``, ``--out-dir``\ =\ *DIRECTORY* - - The directory where the pack should be created - -``install`` [*OPTION*...] *PACK* - - Installs an extension from the bundle *PACK*. - - The command unpacks the extension files and moves them to - the expected location in the user's ``$HOME``, so that it - will be loaded in the next session. - - It is mainly intended for testing, not as a replacement for - the extension website. As extensions have privileged access - to the user's session, it is advised to never load extensions - from untrusted sources without carefully reviewing their content. - - **Options** - - ``--force`` - - Override an existing extension - -``uninstall`` *UUID* - - Uninstalls the extension identified by *UUID*. - - -EXIT STATUS ------------ -On success 0 is returned, a non-zero failure code otherwise. - -BUGS ----- -The tool is part of the gnome-shell project, and bugs should be reported -in its issue tracker at https://gitlab.gnome.org/GNOME/gnome-shell/issues. diff --git a/subprojects/extensions-tool/man/meson.build b/subprojects/extensions-tool/man/meson.build index 697211736..6148c4093 100644 --- a/subprojects/extensions-tool/man/meson.build +++ b/subprojects/extensions-tool/man/meson.build @@ -1,5 +1,5 @@ custom_target('gnome-extensions.1', - input: 'gnome-extensions.txt', + input: 'gnome-extensions.rst', output: 'gnome-extensions.1', command: [rst2man, '--syntax-highlight=none', '@INPUT@'], capture: true,